Skip to content

docs: qualify README API coverage and raw access claims - #1185

Merged
joshrotenberg merged 2 commits into
mainfrom
docs/coverage-claims
Oct 9, 2026
Merged

joshrotenberg merged 2 commits into
mainfrom
docs/coverage-claims

Conversation

@joshrotenberg

@joshrotenberg joshrotenberg commented Oct 7, 2026 •

Copy link
Copy Markdown
Collaborator

Scope

README-only contribution to #1085; leaves #1085 open.

Replaced five absolute/universal claims with descriptive Cloud/Enterprise/MCP/database capability language. Added an explicit CLI-vs-MCP/product-version qualifier, linked the unfinished support/validation matrix, and clarified that raw API requests remain subject to upstream endpoint availability, payloads and permissions.

No full matrix or new supported/tested version/architecture claims. No runtime, defaults, credentials, configuration schema, CI/settings policy or release changes. Other open PRs remain untouched.

Validation

  • Focused static assertion: all five identified absolute claims removed, required qualifiers present, and every existing fenced example unchanged against main.
  • Whole-file Markdown lint still has exactly the five baseline diagnostics (MD060 x4, MD032 x1); normalized diagnostics match and no suppression added.
  • New docs(1.0): publish a support matrix and evidence-based coverage claims #1085 link returned HTTP 200. Repository search found no references to the renamed heading anchors; external bookmarks cannot be inventoried.
  • Diff check and required formatting/all-target/all-feature Clippy passed before push (cold kickoff Clippy 1m02s; final 0.77s).
  • Independent read-only agent review at the exact pushed head found no actionable findings. Prose matches the current compatibility policy, CLI parser and raw request dispatch. Review did not claim live API coverage or run broad suites.
  • Local unit/integration/strict site suites were not repeated for this README-only change. Hosted exact-head CI is complete: 15 successful checks and seven expected PR-only/main-only skips. Required unit/integration/Linux validation passed; macOS/Windows builds, strict MkDocs, link-check and Rustdoc jobs also passed. Markdown lint remains advisory; the five local baseline diagnostics are still tracked as existing debt.

Checkpoint

Head: bc3c40b80b70e5bbdd61c0e40c29ef5c08bb4e27.
Implementation, focused local validation and independent review finished. Exact-head hosted checks reconciled (including individual mandatory jobs/steps, not just aggregate status); ready for required human review. No merge/release. The full #1085 support matrix remains outstanding.

CI · Documentation · Release plan.

@joshrotenberg joshrotenberg left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. The revised claims are accurate and match what the repo ships. Only optional nits below.

I checked the changes against these sources:

  • "300+ tools" (README hunk 1, wording unchanged): this still holds as a lower bound. AGENTS.md lists about 364 tools, and crates/redisctl-mcp/Cargo.toml enables cloud, enterprise and database by default.
  • Raw API wording (hunk 3): this matches docs/docs/reference/compatibility.md:38, which says endpoint availability and payloads are controlled by the upstream service. The example redisctl api cloud get ... matches the HttpMethod enum in crates/redisctl/src/cli/mod.rs:283.
  • Matrix link (hunk 2): it points to the same issue (#1085) that compatibility.md:43 links.
  • Renamed headings and removed claims: changing "Full API Coverage" to "Management" and "any Redis instance" to "Redis" removes the overclaims. The listed areas did not change.

Findings:

  • nit (README, "Key Capabilities", Raw API bullet): compatibility.md:38 marks raw Cloud/Enterprise API access as Preview. Consider adding "(preview)" so the README matches the compatibility table.
  • nit (README, "What's Covered" intro): the README calls it a "support and validation matrix" but compatibility.md:43 calls it a "support matrix". Using one name in both places makes them easier to cross-reference.
  • nit (README, MCP Server paragraph, wording unchanged): "300+ tools" assumes the default features. A short "with default features" would keep the count correct for --no-default-features builds. This was already the case before this PR, so it's optional here.

I found no broken links, stale version numbers or changed command examples.

@joshrotenberg
joshrotenberg merged commit a2f5cf6 into main Oct 9, 2026
22 checks passed
@joshrotenberg
joshrotenberg deleted the docs/coverage-claims branch October 9, 2026 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant